Draws a separator line.

OSStatus DrawThemeSeparator (
    const Rect *inRect, 
    ThemeDrawState inState
);

inRect

A pointer to a structure of type Rect. Before calling DrawThemeSeparator, set the rectangle to contain the separator line, in local coordinates. The orientation of the rectangle determines where the separator line is drawn. If the rectangle is wider than it is tall, the separator line is horizontal; otherwise it is vertical.

inState

A value of type ThemeDrawState. Pass a constant specifying the state in which to draw the separator line; see “Theme Draw State Constants”. The separator line can be drawn as active or inactive; passing kThemeStatePressed produces an error.

function result

A result code.

DISCUSSION

The DrawThemeSeparator function draws a theme-compliant separator line. The separator line is a maximum of 2 pixels thick and is drawn inside the specified rectangle.

VERSION NOTES

This function is available with Appearance Manager 1.0 and later.

AVAILABILITY

Supported in Carbon. Available in Mac OS 8.1 and later when Carbon 1.0.2 or later is present.

© 2000 Apple Computer, Inc. — (Last Updated 5/8/2000)